Platform Explorer / Nuxeo Platform 2023.6

Extension point treeInstance

Documentation

Used to register actual publication tree instances, where we define the factory to use, the underlying tree to use, its name / title.

Here is the default contribution:

    <publicationTreeConfig factory="CoreProxy"
        name="DefaultSectionsTree"
        title="label.publication.tree.local.sections" tree="RootSectionsCoreTree">
        <parameters>
            <!-- <parameter name="RootPath">/default-domain/sections</parameter> -->
            <parameter name="RelativeRootPath">/sections</parameter>
            <parameter name="enableSnapshot">true</parameter>
            <parameter name="iconExpanded">/icons/folder_open.gif</parameter>
            <parameter name="iconCollapsed">/icons/folder.gif</parameter>
        </parameters>
    </publicationTreeConfig>

Parameters: - RootPath: it's used when you want to define the root publication node of your PublicationTree. You can't use RootPath AND RelativeRoothPath parameter.

- RelativeRootPath: used when you just want to define a relative path (without specifying the domain path). A PublicationTree instance will be created automatically for each Domain, appending the RelativeroothPath value to each Domain.

- iconExpanded and iconCollapsed: specify which icons to use when displaying the PublicationTree on the interface.

Contribution Descriptors

  • Class: org.nuxeo.ecm.platform.publisher.descriptors.PublicationTreeConfigDescriptor

Existing Contributions

Contributions are presented in the same order as the registration order on this extension point. This order is displayed before the contribution name, in brackets.

  • nuxeo-platform-publisher-2023.6.12.jar /OSGI-INF/publisher-contrib.xml
    <extension point="treeInstance" target="org.nuxeo.ecm.platform.publisher.impl.service.PublisherServiceImpl">
    
        <documentation>
          Contribute the default PublicationTree instance to be able to publish
          documents in local sections.
        </documentation>
    
        <publicationTreeConfig factory="CoreProxy" name="DefaultSectionsTree" title="label.publication.tree.local.sections" tree="RootSectionsCoreTree">
          <parameters>
            <!-- <parameter name="RootPath">/default-domain/sections</parameter> -->
            <parameter name="RelativeRootPath">/sections</parameter>
            <parameter name="enableSnapshot">true</parameter>
            <parameter name="iconExpanded">/icons/folder_open.gif</parameter>
            <parameter name="iconCollapsed">/icons/folder.gif</parameter>
          </parameters>
        </publicationTreeConfig>
    
      </extension>
  • nuxeo-platform-publisher-2023.6.12.jar /OSGI-INF/publisher-task-contrib.xml
    <extension point="treeInstance" target="org.nuxeo.ecm.platform.publisher.impl.service.PublisherServiceImpl">
    
        <publicationTreeConfig factory="CoreProxyWithWorkflow" name="DefaultSectionsTree" title="label.publication.tree.local.sections" tree="RootSectionsCoreTree">
          <parameters>
            <!-- <parameter name="RootPath">/default-domain/sections</parameter> -->
            <parameter name="RelativeRootPath">/sections</parameter>
            <parameter name="enableSnapshot">true</parameter>
            <parameter name="iconExpanded">/icons/folder_open.gif</parameter>
            <parameter name="iconCollapsed">/icons/folder.gif</parameter>
          </parameters>
        </publicationTreeConfig>
    
      </extension>
  • nuxeo-platform-rendition-publisher-2023.6.12.jar /OSGI-INF/rendition-publisher-contrib.xml
    <extension point="treeInstance" target="org.nuxeo.ecm.platform.publisher.impl.service.PublisherServiceImpl">
    
        <documentation>
          Override the default PublicationTree used in Nuxeo to use the one handling
          Rendition documents.
        </documentation>
        <publicationTreeConfig factory="RenditionPublication" name="DefaultSectionsTree" title="label.publication.tree.local.sections" tree="RenditionPublicationCoreTree">
          <parameters>
            <!-- <parameter name="RootPath">/default-domain/sections</parameter> -->
            <parameter name="RelativeRootPath">/sections</parameter>
            <parameter name="enableSnapshot">true</parameter>
            <parameter name="iconExpanded">/icons/folder_open.gif</parameter>
            <parameter name="iconCollapsed">/icons/folder.gif</parameter>
          </parameters>
        </publicationTreeConfig>
    
      </extension>